Fix links in quick start guide #8893
Conversation
📝 WalkthroughWalkthroughA documentation file was updated to convert bare link references to properly formatted Markdown links, improving the presentation and navigation experience in rendered documentation without altering actual content. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/source/quick-start-guide.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: venkywonka
Repo: NVIDIA/TensorRT-LLM PR: 6029
File: .github/pull_request_template.md:45-53
Timestamp: 2025-08-27T17:50:13.264Z
Learning: For PR templates in TensorRT-LLM, avoid suggesting changes that would increase developer overhead, such as converting plain bullets to mandatory checkboxes. The team prefers guidance-style bullets that don't require explicit interaction to reduce friction in the PR creation process.
Learnt from: farshadghodsian
Repo: NVIDIA/TensorRT-LLM PR: 7101
File: docs/source/blogs/tech_blog/blog9_Deploying_GPT_OSS_on_TRTLLM.md:36-36
Timestamp: 2025-08-21T00:16:56.457Z
Learning: TensorRT-LLM container release tags in documentation should only reference published NGC container images. The README badge version may be ahead of the actual published container versions.
📚 Learning: 2025-07-28T17:06:08.621Z
Learnt from: moraxu
Repo: NVIDIA/TensorRT-LLM PR: 6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.
Applied to files:
docs/source/quick-start-guide.md
📚 Learning: 2025-08-01T15:14:45.673Z
Learnt from: yibinl-nvidia
Repo: NVIDIA/TensorRT-LLM PR: 6506
File: examples/models/core/mixtral/requirements.txt:3-3
Timestamp: 2025-08-01T15:14:45.673Z
Learning: In TensorRT-LLM, examples directory can have different dependency versions than the root requirements.txt file. Version conflicts between root and examples dependencies are acceptable because examples are designed to be standalone and self-contained.
Applied to files:
docs/source/quick-start-guide.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Pre-commit Check
|
|
||
| You can also directly load pre-quantized models [quantized checkpoints on Hugging Face](https://huggingface.co/collections/nvidia/model-optimizer-66aa84f7966b3150262481a4) in the LLM constructor. | ||
| To learn more about the LLM API, check out the [](llm-api/index) and [](examples/llm_api_examples). | ||
| To learn more about the LLM API, check out the [docs](llm-api/index) and [examples](examples/llm_api_examples). |
There was a problem hiding this comment.
🧩 Analysis chain
Verify that the documentation link targets exist and render correctly.
The Markdown link formatting looks good and aligns with the PR objective. However, confirm that the paths llm-api/index and examples/llm_api_examples exist in the documentation structure and resolve correctly when the docs are built.
Run the following verification to check that the linked paths exist:
🏁 Script executed:
#!/bin/bash
# Description: Verify that the linked documentation paths exist.
# Find paths matching the link targets
echo "Searching for llm-api documentation..."
fd -t d "llm-api" docs/
echo "Searching for llm_api_examples..."
fd -t d "llm_api_examples" docs/
# Also check for .rst or .md files that might correspond to these links
echo "Checking for index files in llm-api..."
fd "index\.(rst|md)" docs/source/llm-api
echo "Checking for llm_api_examples content..."
fd "llm_api_examples\.(rst|md|html)" docs/Length of output: 202
I found an issue with the verification results. Let me search for what actually exists in the examples directory:
Let me search for what exists in the examples directory:
I need to check what actually exists in the examples directory. Let me run a direct search:Now let me run a simple script to check what files exist in the examples directory:
🏁 Script executed:
#!/bin/bash
# Description: List all items in docs/source/examples directory
echo "=== Listing all items in docs/source/examples ==="
if [ -d "docs/source/examples" ]; then
ls -la docs/source/examples
else
echo "Directory docs/source/examples does not exist"
fi
echo ""
echo "=== Searching for 'examples' directory ==="
find docs -type d -name "examples" 2>/dev/null
echo ""
echo "=== Searching for any file/dir with 'llm' in name under docs ==="
find docs -iname "*llm*" 2>/dev/nullLength of output: 205
Critical issue found. The second link target doesn't exist. Let me check the docs structure to find the correct path:
🏁 Script executed:
#!/bin/bash
# Description: Map out docs/source directory structure
echo "=== Top-level contents of docs/source ==="
ls -la docs/source | grep -E '^d'
echo ""
echo "=== Search for any file mentioning llm_api_examples ==="
rg -n "llm_api_examples" docs/ 2>/dev/null || echo "No matches found"
echo ""
echo "=== Check if there's example content elsewhere ==="
find docs -type f -name "*example*" 2>/dev/null | head -20Length of output: 226
Let me verify that the file under review actually exists and check the docs structure more broadly:
---
🏁 Script executed:
```shell
#!/bin/bash
# Description: Verify file under review and check docs structure
echo "=== Check if the file under review exists ==="
cat docs/source/quick-start-guide.md 2>/dev/null | head -100 || echo "File not found"
echo ""
echo "=== List all directories at docs root ==="
find docs -maxdepth 2 -type d 2>/dev/null | sort
echo ""
echo "=== Find quick-start-guide file ==="
find . -name "quick-start-guide.md" 2>/dev/null
Length of output: 4143
Now let me check what exists in the docs/source/examples directory:
---
🏁 Script executed:
```shell
#!/bin/bash
# Description: Check contents of docs/source/examples
echo "=== Contents of docs/source/examples ==="
ls -la docs/source/examples 2>/dev/null || echo "Directory listing failed"
echo ""
echo "=== Search for llm_api_examples in examples ==="
find docs/source/examples -name "*llm_api*" 2>/dev/null || echo "No matches"
echo ""
echo "=== All files in docs/source/examples ==="
find docs/source/examples -type f 2>/dev/null | sort
echo ""
echo "=== All directories in docs/source/examples ==="
find docs/source/examples -type d 2>/dev/null | sort
Length of output: 994
Fix broken documentation link on line 91 - examples/llm_api_examples does not exist.
The second link target does not exist in the documentation structure. The docs/source/examples/ directory contains:
- customization.md
- dynamo_k8s_example.rst
- index.rst (likely the correct target)
- kvcacheconfig.md
- kvcacheretentionconfig.md
Change examples/llm_api_examples to the correct path, likely examples/index or another existing documentation file appropriate for LLM API examples.
The first link llm-api/index is valid and resolves correctly to docs/source/llm-api/index.md.
🤖 Prompt for AI Agents
In docs/source/quick-start-guide.md around line 91, the second link target
"examples/llm_api_examples" is invalid; replace it with the correct existing
documentation path (e.g., "examples/index") so the link points to
docs/source/examples/index.rst (or another appropriate file under
docs/source/examples/) and ensure the markdown link becomes
[examples](examples/index).
1 participant
Add link descriptions for LLM API in quickstart guide
Summary by CodeRabbit